HCL Lotus Expeditor wiki: Using the Lotus Expeditor Integrator Platform: Using Expeditor Integrator Reference Information

Using Expeditor Integrator Reference Information

Added by ~Zach Cisnupulader | Edited by ~Emile Xannilynivu on May 31, 2013 | Version 2

Actions ▼

Abstract

Abstract

No abstract provided.

Tags: Integrator

ShowTable of Contents

HideTable of Contents

1 APPENDIX A – Example Messages
2 APPENDIX B – Develop messaging client applications using IBM micro broker clients
3 APPENDIX C – GLOSSARY

This section contains example listings of selected XML messages.

APPENDIX A – Example Messages

DBRecordUpdate message with SQL statement

Create Table Example (SQL)

Listing 45: XML message example for creating table menu in a local Derby database SampleDb using SQL in message payload

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<content>

    <entry type="1">

        <textMessage JMSDeliveryMode="2" JMSExpiration="0" JMSMessageID="ID:C1BC481C828AC4132618A8A77938561E79A15D2700000000" JMSPriority="4" JMSRedelivered="false" JMSTimestamp="1228167617826">

            <headerProperty name="LocationId" type="java.lang.String" value="Store2100"/>

            <headerProperty name="MessageId" type="java.lang.String" value="SF_DbRecUpd_MsgId-Test_001"/>

            <headerProperty name="TransactionId" type="java.lang.String" value="SF_DbRecUpd_TxId-Test_001"/>

            <headerProperty name="HeaderVersion" type="java.lang.String" value="2.0"/>

            <headerProperty name="MessagePurpose" type="java.lang.String" value="DBRecordUpdate"/>

            <headerProperty name="TransportType" type="java.lang.String" value="DB"/>

            <headerProperty name="ResourceCmd" type="java.lang.String" value="SQL"/>

            <headerProperty name="DestinationCreationMode" type="java.lang.String" value="TABLE_CREATE"/>

            <headerProperty name="DestinationPath" type="java.lang.String" value="DBURI:'jdbc:derby:datatrans/inbound/SampleDb;create=true';DRIVER_CLASS:'org.apache.derby.jdbc.EmbeddedDriver'"/>

            <headerProperty name="DestinationName" type="java.lang.String" value="menu"/>

            <headerProperty name="TransferMode" type="java.lang.String" value="ASCII"/>

            <headerProperty name="SequenceNo" type="java.lang.Integer" value="0"/>

            <headerProperty name="EndOfData" type="java.lang.Boolean" value="true"/>

            <headerProperty name="BuildInterval" type="java.lang.Long" value="0"/>

            <headerProperty name="ResourceSize" type="java.lang.Long" value="991"/>

            <headerProperty name="TimeStamp" type="java.lang.String" value="Mon Dec 01 21:52:43 CET 2008"/>

            <headerProperty name="TTL" type="java.lang.Long" value="0"/>

            <headerProperty name="MessageSrcId" type="java.lang.String" value="Local_Message_Editor"/>

            <text>CREATE TABLE menu(course CHAR(10), item CHAR(20), price INTEGER);</text>

        </textMessage>

    </entry>

</content>

Insert Data Example (SQL)

Listing 46: XML message example for inserting data into table menu of local Derby database SampleDb using SQL in message payload

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<content>

    <entry type="1">

        <textMessage JMSDeliveryMode="2" JMSExpiration="0" JMSMessageID="ID:C1BC481C828AC4132618A8A77938561E79A15D2700000000" JMSPriority="4" JMSRedelivered="false" JMSTimestamp="1228167617826">

            <headerProperty name="LocationId" type="java.lang.String" value="Store2100"/>

            <headerProperty name="MessageId" type="java.lang.String" value="SF_DbRecUpd_MsgId-Test_002"/>

            <headerProperty name="TransactionId" type="java.lang.String" value="SF_DbRecUpd_TxId-Test_002"/>

            <headerProperty name="HeaderVersion" type="java.lang.String" value="2.0"/>

            <headerProperty name="MessagePurpose" type="java.lang.String" value="DBRecordUpdate"/>

            <headerProperty name="TransportType" type="java.lang.String" value="DB"/>

            <headerProperty name="ResourceCmd" type="java.lang.String" value="SQL"/>

            <headerProperty name="DestinationCreationMode" type="java.lang.String" value="INSERT"/>

            <headerProperty name="DestinationPath" type="java.lang.String" value="DBURI:'jdbc:derby:datatrans/inbound/SampleDb';DRIVER_CLASS:'org.apache.derby.jdbc.EmbeddedDriver'"/>

            <headerProperty name="DestinationName" type="java.lang.String" value="menu"/>

            <headerProperty name="TransferMode" type="java.lang.String" value="ASCII"/>

            <headerProperty name="SequenceNo" type="java.lang.Integer" value="0"/>

            <headerProperty name="EndOfData" type="java.lang.Boolean" value="true"/>

            <headerProperty name="BuildInterval" type="java.lang.Long" value="0"/>

            <headerProperty name="ResourceSize" type="java.lang.Long" value="991"/>

            <headerProperty name="TimeStamp" type="java.lang.String" value="Mon Dec 01 21:52:43 CET 2008"/>

            <headerProperty name="TTL" type="java.lang.Long" value="0"/>

            <headerProperty name="MessageSrcId" type="java.lang.String" value="Local_Message_Editor"/>

            <text>INSERT INTO menu VALUES ('appetizer','baby greens',7);INSERT INTO menu VALUES ('entree','lamb chops ',6);INSERT INTO menu VALUES ('dessert','creme brulee',14);</text>

        </textMessage>

    </entry>

</content>

DBRecordUpdate message with XPDINTEG_DBXML command and data structure

Note: The <XPDinteg_DBxml_data_structure> must be escaped within the <text> tag of an XML message (see Listing 44).

Listing 47: XML message example for creating table menu in a local Derby database SampleDb using <XPDinteg_DBdata_xml_structure> in message payload

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<content>

    <entry type="1">

        <textMessage JMSDeliveryMode="2" JMSExpiration="0" JMSMessageID="ID:C1BC481C828AC4132618A8A77938561E79A15D2700000000" JMSPriority="4" JMSRedelivered="false" JMSTimestamp="1228167617826">

            <headerProperty name="LocationId" type="java.lang.String" value="Store2100"/>

            <headerProperty name="MessageId" type="java.lang.String" value="SF_DbRecUpd_MsgId-Test_011"/>

            <headerProperty name="TransactionId" type="java.lang.String" value="SF_DbRecUpd_TxId-Test_011"/>

            <headerProperty name="HeaderVersion" type="java.lang.String" value="2.0"/>

            <headerProperty name="MessagePurpose" type="java.lang.String" value="DBRecordUpdate"/>

            <headerProperty name="TransportType" type="java.lang.String" value="DB"/>

            <headerProperty name="ResourceCmd" type="java.lang.String" value="XPDINTEG_DBXML"/>

            <headerProperty name="DestinationCreationMode" type="java.lang.String" value="TABLE_CREATE"/>

            <headerProperty name="DestinationPath" type="java.lang.String" value="DBURI:'jdbc:derby:datatrans/inbound/SampleDb;create=true';DRIVER_CLASS:'org.apache.derby.jdbc.EmbeddedDriver'"/>

            <headerProperty name="DestinationName" type="java.lang.String" value="menu"/>

            <headerProperty name="TransferMode" type="java.lang.String" value="ASCII"/>

            <headerProperty name="SequenceNo" type="java.lang.Integer" value="0"/>

            <headerProperty name="EndOfData" type="java.lang.Boolean" value="true"/>

            <headerProperty name="BuildInterval" type="java.lang.Long" value="0"/>

            <headerProperty name="ResourceSize" type="java.lang.Long" value="991"/>

            <headerProperty name="TimeStamp" type="java.lang.String" value="Mon Dec 01 21:52:43 CET 2008"/>

            <headerProperty name="TTL" type="java.lang.Long" value="0"/>

            <headerProperty name="MessageSrcId" type="java.lang.String" value="Local_Message_Editor"/>

            <text>&lt;?xml version="1.0" encoding="utf-8" ?&gt;

            &lt;!-- COMMAND --&gt;

            &lt;database-command&gt;

            &lt;create table-name="menu"&gt;

              &lt;create-clause&gt;course CHAR(10), item CHAR(20), price INTEGER&lt;/create-clause&gt;

                &lt;/create&gt;

              &lt;/database-command&gt;

            &lt;!--DATA --&gt;

            </text>

        </textMessage>

    </entry>

</content>

INSERT Data Example using @nowiki@4 structure

Listing 48: XML message example for inserting data into table menu of local Derby database SampleDb using <XPDinteg_DBdata_xml_structure> in message payload

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<content>

    <entry type="1">

        <textMessage JMSDeliveryMode="2" JMSExpiration="0" JMSMessageID="ID:C1BC481C828AC4132618A8A77938561E79A15D2700000000" JMSPriority="4" JMSRedelivered="false" JMSTimestamp="1228167617826">

            <headerProperty name="LocationId" type="java.lang.String" value="Store2100"/>

            <headerProperty name="MessageId" type="java.lang.String" value="SF_DbRecUpd_MsgId-Test_012"/>

            <headerProperty name="TransactionId" type="java.lang.String" value="SF_DbRecUpd_TxId-Test_012"/>

            <headerProperty name="HeaderVersion" type="java.lang.String" value="2.0"/>

            <headerProperty name="MessagePurpose" type="java.lang.String" value="DBRecordUpdate"/>

            <headerProperty name="TransportType" type="java.lang.String" value="DB"/>

            <headerProperty name="ResourceCmd" type="java.lang.String" value="XPDINTEG_DBXML"/>

            <headerProperty name="DestinationCreationMode" type="java.lang.String" value="INSERT"/>

            <headerProperty name="DestinationPath" type="java.lang.String" value="DBURI:'jdbc:derby:datatrans/inbound/SampleDb';DRIVER_CLASS:'org.apache.derby.jdbc.EmbeddedDriver'"/>

            <headerProperty name="DestinationName" type="java.lang.String" value="menu"/>

            <headerProperty name="TransferMode" type="java.lang.String" value="ASCII"/>

            <headerProperty name="SequenceNo" type="java.lang.Integer" value="0"/>

            <headerProperty name="EndOfData" type="java.lang.Boolean" value="true"/>

            <headerProperty name="BuildInterval" type="java.lang.Long" value="0"/>

            <headerProperty name="ResourceSize" type="java.lang.Long" value="991"/>

            <headerProperty name="TimeStamp" type="java.lang.String" value="Mon Dec 01 21:52:43 CET 2008"/>

            <headerProperty name="TTL" type="java.lang.Long" value="0"/>

            <headerProperty name="MessageSrcId" type="java.lang.String" value="Local_Message_Editor"/>

            <text>&lt;?xml version="1.0" encoding="utf-8" ?&gt;

	             &lt;!-- COMMAND --&gt;

	             &lt;database-command&gt;

	             &lt;insert table-name="menu"&gt;

	             &lt;column name="course" type="string"&gt;appetizer&lt;/column&gt;

	             &lt;column name="item" type="string"&gt;baby greens&lt;/column&gt;

	             &lt;column name="price" type="int"&gt;7&lt;/column&gt;

	             &lt;/insert&gt;

	             &lt;insert table-name="menu"&gt;

	             &lt;column name="course" type="string"&gt;entree&lt;/column&gt;

	             &lt;column name="item" type="string"&gt;lamb chops&lt;/column&gt;

	             &lt;column name="price" type="int"&gt;6&lt;/column&gt;

	             &lt;/insert&gt;

	             &lt;insert table-name="menu"&gt;

	             &lt;column name="course" type="string"&gt;dessert&lt;/column&gt;

	             &lt;column name="item" type="string"&gt;creme brulee&lt;/column&gt;

	             &lt;column name="price" type="int"&gt;14&lt;/column&gt;

	             &lt;/insert&gt;               &lt;/database-command&gt;

	             &lt;!--DATA --&gt;

           </text>

        </textMessage>

    </entry>

</content>

UPDATE Data Example using @nowiki@6 structure

Listing 49: XML message example for updating data in table menu of local Derby database SampleDb using <XPDinteg_DBdata_xml_structure> in message payload

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<content>

    <entry type="1">

        <textMessage JMSDeliveryMode="2" JMSExpiration="0" JMSMessageID="ID:C1BC481C828AC4132618A8A77938561E79A15D2700000000" JMSPriority="4" JMSRedelivered="false" JMSTimestamp="1228167617826">

            <headerProperty name="LocationId" type="java.lang.String" value="Store2100"/>

            <headerProperty name="MessageId" type="java.lang.String" value="SF_DbRecUpd_MsgId-Test_1013"/>

            <headerProperty name="TransactionId" type="java.lang.String" value="SF_DbRecUpd_TxId-Test_1013"/>

            <headerProperty name="HeaderVersion" type="java.lang.String" value="2.0"/>

            <headerProperty name="MessagePurpose" type="java.lang.String" value="DBRecordUpdate"/>

            <headerProperty name="TransportType" type="java.lang.String" value="DB"/>

            <headerProperty name="ResourceCmd" type="java.lang.String" value="XPDINTEG_DBXML"/>

            <headerProperty name="DestinationCreationMode" type="java.lang.String" value="UPDATE"/>

            <headerProperty name="DestinationPath" type="java.lang.String" value="DBURI:'jdbc:derby:datatrans/inbound/SampleDb';DRIVER_CLASS:'org.apache.derby.jdbc.EmbeddedDriver'"/>

            <headerProperty name="DestinationName" type="java.lang.String" value="menu"/>

            <headerProperty name="TransferMode" type="java.lang.String" value="ASCII"/>

            <headerProperty name="SequenceNo" type="java.lang.Integer" value="0"/>

            <headerProperty name="EndOfData" type="java.lang.Boolean" value="true"/>

            <headerProperty name="BuildInterval" type="java.lang.Long" value="0"/>

            <headerProperty name="ResourceSize" type="java.lang.Long" value="991"/>

            <headerProperty name="TimeStamp" type="java.lang.String" value="Mon Dec 01 21:52:43 CET 2008"/>

            <headerProperty name="TTL" type="java.lang.Long" value="0"/>

            <headerProperty name="MessageSrcId" type="java.lang.String" value="SFs_HermesJMS"/>

            <text>&lt;?xml version="1.0" encoding="utf-8" ?&gt;

            &lt;!-- COMMAND --&gt;

              &lt;database-command&gt;

                &lt;update table-name="menu"&gt;

                  &lt;set-clause&gt;

                    &lt;column name="price" type="expr"&gt;price+2&lt;/column&gt;

                    &lt;column name="course" type="string"&gt;starter&lt;/column&gt;

                  &lt;/set-clause&gt;

                  &lt;where-clause type="string"&gt;course=&apos;dessert&apos;&lt;/where-clause&gt;

                &lt;/update&gt;

                &lt;update table-name="menu"&gt;

                  &lt;set-clause&gt;

                    &lt;column name="course" type="string"&gt;main&lt;/column&gt;

                  &lt;/set-clause&gt;

                  &lt;where-clause type="string"&gt;item=&apos;lamb chops&apos;&lt;/where-clause&gt;

                &lt;/update&gt;

              &lt;/database-command&gt;

            &lt;!--DATA --&gt;

            </text>

        </textMessage>

    </entry>

</content>

UPDATE_INSERT Data Example using @nowiki@8 structure

Listing 50: XML message example for updating data in table menu of local Derby database SampleDb using <XPDinteg_DBdata_xml_structure> in message payload. If updated record does not exist the next insert statement is executed.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<content>

    <entry type="1">

        <textMessage JMSDeliveryMode="2" JMSExpiration="0" JMSMessageID="ID:C1BC481C828AC4132618A8A77938561E79A15D2700000000" JMSPriority="4" JMSRedelivered="false" JMSTimestamp="1228167617826">

            <headerProperty name="LocationId" type="java.lang.String" value="Store2100"/>

            <headerProperty name="MessageId" type="java.lang.String" value="SF_DbRecUpd_MsgId-Test_1014"/>

            <headerProperty name="TransactionId" type="java.lang.String" value="SF_DbRecUpd_TxId-Test_1014"/>

            <headerProperty name="HeaderVersion" type="java.lang.String" value="2.0"/>

            <headerProperty name="MessagePurpose" type="java.lang.String" value="DBRecordUpdate"/>

            <headerProperty name="TransportType" type="java.lang.String" value="DB"/>

            <headerProperty name="ResourceCmd" type="java.lang.String" value="XPDINTEG_DBXML"/>

            <headerProperty name="DestinationCreationMode" type="java.lang.String" value="UPDATE_INSERT"/>

            <headerProperty name="DestinationPath" type="java.lang.String" value="DBURI:'jdbc:derby:datatrans/inbound/SampleDb';DRIVER_CLASS:'org.apache.derby.jdbc.EmbeddedDriver'"/>

            <headerProperty name="DestinationName" type="java.lang.String" value="menu"/>

            <headerProperty name="TransferMode" type="java.lang.String" value="ASCII"/>

            <headerProperty name="SequenceNo" type="java.lang.Integer" value="0"/>

            <headerProperty name="EndOfData" type="java.lang.Boolean" value="true"/>

            <headerProperty name="BuildInterval" type="java.lang.Long" value="0"/>

            <headerProperty name="ResourceSize" type="java.lang.Long" value="991"/>

            <headerProperty name="TimeStamp" type="java.lang.String" value="Mon Dec 01 21:52:43 CET 2008"/>

            <headerProperty name="TTL" type="java.lang.Long" value="0"/>

            <headerProperty name="MessageSrcId" type="java.lang.String" value="SFs_HermesJMS"/>

            <text> &lt;?xml version="1.0" encoding="utf-8" ?&gt;

            &lt;!-- COMMAND --&gt;

              &lt;database-command&gt;

                &lt;update_insert table-name="menu"&gt;

                  &lt;set-clause&gt;

                    &lt;column name="price" type="expr"&gt;price+3&lt;/column&gt;

                  &lt;/set-clause&gt;

                  &lt;where-clause type="string"&gt;course=&apos;dessert&apos;&lt;/where-clause&gt;

                  &lt;insert table-name="menu"&gt;

                    &lt;column name="course" type="string"&gt;dessert&lt;/column&gt;

                    &lt;column name="item" type="string"&gt;apfelstrudel&lt;/column&gt;

                    &lt;column name="price" type="int"&gt;3&lt;/column&gt;

                  &lt;/insert&gt;

                &lt;/update_insert&gt;

              &lt;/database-command&gt;

            &lt;!--DATA --&gt;

            </text>

        </textMessage>

    </entry>

</content>

DBRecordSelect message with SQL statement

Select Message Example (SQL)

Listing 51: XML message example for selecting data from table menu of local Derby database SampleDb using SQL in message payload

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<content>

    <entry type="1">

        <textMessage JMSDeliveryMode="2" JMSExpiration="0" JMSMessageID="ID:C1BC481C828AC4132618A8A77938561E79A15D2700000000" JMSPriority="4" JMSRedelivered="false" JMSTimestamp="1228167617826">

            <headerProperty name="LocationId" type="java.lang.String" value="Store2100"/>

            <headerProperty name="MessageId" type="java.lang.String" value="SF_DbRecSel_MsgId-Test_1022"/>

            <headerProperty name="TransactionId" type="java.lang.String" value="SF_DbRecSel_TxId-Test_1022"/>

            <headerProperty name="HeaderVersion" type="java.lang.String" value="2.0"/>

            <headerProperty name="MessagePurpose" type="java.lang.String" value="DBRecordSelect"/>

            <headerProperty name="TransportType" type="java.lang.String" value="DB"/>

            <headerProperty name="ResourceCmd" type="java.lang.String" value="SQL"/>

            <headerProperty name="DestinationPath" type="java.lang.String" value="DBURI:'jdbc:derby:datatrans/inbound/SampleDb';DRIVER_CLASS:'org.apache.derby.jdbc.EmbeddedDriver'"/>

            <headerProperty name="DestinationName" type="java.lang.String" value="menu"/>

            <headerProperty name="TransferMode" type="java.lang.String" value="ASCII"/>

            <headerProperty name="SequenceNo" type="java.lang.Integer" value="0"/>

            <headerProperty name="EndOfData" type="java.lang.Boolean" value="true"/>

            <headerProperty name="BuildInterval" type="java.lang.Long" value="0"/>

            <headerProperty name="ResourceSize" type="java.lang.Long" value="991"/>

            <headerProperty name="TimeStamp" type="java.lang.String" value="Mon Dec 01 21:52:43 CET 2008"/>

            <headerProperty name="TTL" type="java.lang.Long" value="0"/>

            <headerProperty name="MessageSrcId" type="java.lang.String" value="SFs_HermesJMS"/>

            <text>SELECT * FROM menu;</text>

        </textMessage>

    </entry>

</content>

The retrieved database ResultSet is provided back in an XML message (compliant to the <XPDinteg_DBdata_xml_structure>).

Listing 52: Example ResultSet which is provided back as XML message in <XPDinteg_DBdata_xml_structure>

<?xml version="1.0" encoding="utf-8" ?>

  <tables>

    <table name="MENU">

      <row>

        <column name="COURSE" type="CHAR">dessert   </column>

        <column name="ITEM" type="CHAR">creme brulee        </column>

        <column name="PRICE" type="INTEGER">14</column>

      </row>

    </table>

</tables>

DBRecordSelect message with XPDINTEG_DBXML command and data structure

Note: The <XPDinteg_DBxml_data_structure> must be escaped within the <text> tag of an XML message (see Listing 44).

Listing 53: XML message example for selecting data from table menu of local Derby database SampleDb using <XPDinteg_DBxml_data_structure> in message payload

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<content>

    <entry type="1">

        <textMessage JMSDeliveryMode="2" JMSExpiration="0" JMSMessageID="ID:C1BC481C828AC4132618A8A77938561E79A15D2700000000" JMSPriority="4" JMSRedelivered="false" JMSTimestamp="1228167617826">

            <headerProperty name="LocationId" type="java.lang.String" value="Store2100"/>

            <headerProperty name="MessageId" type="java.lang.String" value="SF_DbRecSel_MsgId-Test_1021"/>

            <headerProperty name="TransactionId" type="java.lang.String" value="SF_DbRecSel_TxId-Test_1021"/>

            <headerProperty name="HeaderVersion" type="java.lang.String" value="2.0"/>

            <headerProperty name="MessagePurpose" type="java.lang.String" value="DBRecordSelect"/>

            <headerProperty name="TransportType" type="java.lang.String" value="DB"/>

            <headerProperty name="ResourceCmd" type="java.lang.String" value="XPDINTEG_DBXML"/>

            <headerProperty name="DestinationPath" type="java.lang.String" value="DBURI:'jdbc:derby:datatrans/inbound/SampleDb';DRIVER_CLASS:'org.apache.derby.jdbc.EmbeddedDriver'"/>

            <headerProperty name="DestinationName" type="java.lang.String" value="menu"/>

            <headerProperty name="TransferMode" type="java.lang.String" value="ASCII"/>

            <headerProperty name="SequenceNo" type="java.lang.Integer" value="0"/>

            <headerProperty name="EndOfData" type="java.lang.Boolean" value="true"/>

            <headerProperty name="BuildInterval" type="java.lang.Long" value="0"/>

            <headerProperty name="ResourceSize" type="java.lang.Long" value="991"/>

            <headerProperty name="TimeStamp" type="java.lang.String" value="Mon Dec 01 21:52:43 CET 2008"/>

            <headerProperty name="TTL" type="java.lang.Long" value="0"/>

            <headerProperty name="MessageSrcId" type="java.lang.String" value="SFs_HermesJMS"/>

            <text>&lt;?xml version="1.0" encoding="utf-8" ?&gt;

            &lt;!-- COMMAND --&gt;

              &lt;database-command&gt;

                &lt;select table-name="menu"&gt;

                  &lt;select-clause&gt;*&lt;/select-clause&gt;

                  &lt;where-clause&gt;item=&apos;creme brulee&apos; AND course=&apos;dessert&apos;&lt;/where-clause&gt;

                &lt;/select&gt;

               &lt;/database-command&gt;

            &lt;!--DATA --&gt;

            </text>

        </textMessage>

    </entry>

</content>

The retrieved database ResultSet is provided as <XPDinteg_DBxml_data_structure> format in XML reply messages (see example in Listing 52).

APPENDIX B – Develop messaging client applications using IBM micro broker clients

This section contains basic information and links to references which are helpful when developing applications which use IBM microbroker clients and Expeditor integrator for exchanging data.

There are 3 different (micro broker) MQTT MQTT – messaging protocol for telemetry and transport (see http://www.mqtt.org and http://www.eclipse.org/paho ) messaging clients:

1. MQTT v3 Clients

MQTT v3 clients are available through the OpenSource project PAHO (see www.eclipse.org/paho)

2. MQTT v5 Clients

MQTT v5 Clients are micro broker clients that provide additional features to v3 clients, for example point-to-point messaging (queues).

3. JMS micro broker client (buffered and un-buffered)

These MQTT clients provide the JMS See JMS specification in Ref_9 standard Java messaging interface and can be used in messaging applications to connect to micro broker (or any MQTT broker).

Messaging client applications can connect to IBM Lotus Expeditor integrator using one of these clients. The License of Expeditor integrator product must be checked for restrictions and conditions. For Expeditor integrator customers, the following packages are shipped with Expeditor integrator and can be used with regards to IBM license statements (See Table 31. Please contact your IBM representative in case of license questions.)

Table 31: Mapping of micro broker client, Java Packaging and Expeditor integrator JAR File packaging

Javadoc package name (see microbroker API)	IBM microbroker client component	included in JAR in Expeditor integrator directory = *jarfilename_*
com.ibm.micro.client	MQTT v5 Client	com.ibm.micro.client_
com.ibm.msg.client.mqtt	(microbroker) JMS Client API implementation (including “normal” JMS and buffered JMS clients)	com.ibm.mqttclient.jms_
com.ibm.mqttclient	MQTT v3 Client	com.ibm.mqttclient_ (alternatively, use Eclipse Paho clients from ) http://www.eclipse.org/paho/download.php )
javax.jms	JMS API	javax.jms.jar / jms.jar provided in com.ibm.pvc.jms_.jar
	additional packages (messaging provider, e.g. IBM WebSphere MQ client libs)	in folder com.ibm.msg.client.osgi.jms_: com.ibm.msg.client.commonservices.jar com.ibm.msg.client.jms.internal.jar com.ibm.msg.client.jms.jar com.ibm.msg.client.provider.jar

Required librabries for client application (example that uses MQTT JMS Client):

· MQTT JMS Client:

o com.ibm.mqttclient.jms_.jar

· Additional packages:

o in folder com.ibm.msg.client.osgi.jms_7.0.1.9

§ com.ibm.msg.client.commonservices.jar

§ com.ibm.msg.client.jms.internal.jar

§ com.ibm.msg.client.jms.jar

§ com.ibm.msg.client.provider.jar

o com.ibm.pvc.jms_1.1.0.20120220-1930.jar (containing javax.jms.jar / jms)

o com.ibm.micro.utils_.jar

o com.ibm.micro.utils.extended_.jar

Further information: Reading material, details, JavaDoc, implementation examples:

· Micro broker JavaDoc is provided under Ref_3.

· More micro broker client related information can be found in Ref_4, Ref_5 and Ref_6.

· Information details and example for implementation of micro broker client messaging applications in retail area (with IBM 4690 controller support) are given in Ref_7.

· Messaging security with IBM Expeditor integrator is explained in Ref_8.

APPENDIX C – GLOSSARY

Term	Description
4690 Controller	Point-of-Sale (PoS; till) software controller that manages attached PoS systems
ACS	IBM Lotus Expeditor integrator Application Control Service
Active Directory (AD)	A structure supported by Windows® 2000 that lets any object on a network be tracked and located. Active Directory is the directory service used in Windows 2000 Server and provides the foundation for Windows 2000 distributed networks.
Application	A software or tool based on a product (e.g. Lotus Expeditor)
Authentication	Verifying the identity of a user who is logging on to a computer system or verifying the integrity of a transmitted message.
BUC	Business Use Case
Bundle	Is a Java application that implements the required OSGi Framework services so that it can run in and be managed by the OSGi Service Platform (although referred to as OSGi Bundle).
Business Event	Expeditor integrator events that describe the status of a local business process or transaction. These events can be forwarded to back-end systems.
CBE	Common Base Event: Standardized event format for exchanging events between components of different vendors (see http://www.ibm.com/developerworks/autonomic/library/ac-cbe1/ , 16.01.2008). All Expeditor integrator events use this standard format.
DIF	Data Integration Facility (standardizes POS data to support open standards that are compatible with existing and future store systems)
directory	a hierarchical structure that stores information about objects on the network
DMS	Device Management Service: Component that is provided through IBM’s Access Services. It consists of a server and a client (agent) part. The agent polls the server for device management jobs that it needs to perform (e.g. SW management, configuration, remote control of the Expeditor integrator and it’s platform -> Eclipse). The OMA-DM protocol is used (see http://www.openmobilealliance.org).
DMZ	Demilitarized Zone: zone between two firewalls that separate the Internet (first firewall) and a secured local network (second firewall) from each other.
Domain Name System (DNS)	Hierarchical distributed database used for name/address translation and client-server rendezvous. Domain Name System is the namespace used on the Internet to translate computer and service names into TCP/IP addresses. Active Directory uses DNS as its location service, and so clients find domain controllers via DNS queries.
EAI	Enterprise Application Integration
Eclipse^™	Eclipse is an open source community whose projects are focused on providing an extensible application runtime environment on client devices (incl. graphical user interface), a development platform and application frameworks for building software (see http://www.eclipse.org)
EIF	Event Integration Facility (package contained in Tivoli Enterprise Console, TEC, for creating and sending TEC events).
Global Services Method	IBM’s project management method. It includes descriptions of best-practices, recommendations and examples as well as templates which can be used to manage a project efficiently.
hierarchical namespace	A namespace, such as the DNS namespace and the Active Directory namespace that is hierarchically structured and provides rules that allows the namespace to be partitioned. See also namespace.
I18N	Internationalization
Java^® ME / J2ME	Java^® Micro Edition (Java Standard environment for embedded devices, e.g. gateways, set-top boxes and mobile devices), formerly called Java 2 Micro Edition
jclDesktop	Virtual machine from IBM for Desktop environments that are able to run Java programs
JCA	Java Component Architecture
JTA	Java Transaction Architecture
JNDI	Java Naming Domain Interface
JET	Java Embedded Transaction Container. Transaction container provided in IBM WebSphere Application Server (WAS).
JMS	Java Messaging Service
Kerberos	A security system that authenticates users. Kerberos doesn’t provide authorization to services or databases; it establishes identity at logon, which is used throughout the session. The Kerberos protocol is the primary authentication mechanism in the Windows 200x operating systems.
Lightweight Directory Access Protocol (LDAP)	A protocol used to access a directory service. LDAP is a simplified version of the Directory Access Protocol (DAP), which is used to gain access to X.500 directories. It is the primary access protocol for Active Directory.
Log Event	Standard OSGi Framework event that is fired through the OSGi Event Admin Service when a log entry is created using the OSGi Log Service.
Lotus Expeditor	IBM’s implementation of an Eclipse based client platform for different targets (e.g. Desktop and Devices). Additional IBM Access Services and Platform Services provide remote management, configuration, Portal, Servlet, Transaction, Messaging, JDBC etc. Services (see http://www-142.ibm.com/software/sw-lotus/products/product1.nsf/wdocs/expeditor).
AI	Application Integration: messaging-based back-end infrastructure for application integration
micro broker	Client component (Access Service) delivered with IBM Lotus Expeditor which provides local JMS services.
MQSeries	IBM’s messaging protocol and product series.
OMA^®	Open Mobile Alliance (http://www.openmobilealliance.org) OMA^® is the focal point for the development of mobile service enabler specifications, which support the creation of interoperable end-to-end mobile services. OMA drives service enabler architectures and open enabler interfaces that are independent of the underlying wireless networks and platforms. OMA creates interoperable mobile data service enablers that work across devices, service providers, operators, networks, and geographies. Toward that end, OMA will develop test specifications, encourage third party tool development, and conduct test activities that allow vendors to test their implementations. Consolidation of mobile initiatives like WAP-Forum, SyncML etc.
OMA-DM	OMA Device Management (DM) Working Group: was formed by consolidating the device management activities taking place previously in the former WAP Forum and the former SyncML Initiative. The goal of the Device Management Working Group is to specify protocols and mechanisms that achieve management of mobile devices including the necessary configuration to access services and management of the software on mobile devices (see http://www.openmobilealliance.org/tech/wg_committees/dm.html).
OMA-DS	OMA Data Synchronization (DS) Working Group: The goal of the Data Synchronization Working Group is to continue development of specifications for data synchronization, and to develop other similar specifications, including but not limited to SyncML technology. These specifications will include conformance specifications and a set of best practices that describe how to use the data synchronization technology specifications within the OMA Architecture (see http://www.openmobilealliance.org/tech/wg_committees/ds.html)
OSGi^™	Open Services Gateway Initiative (standard for a Java application framework especially designed for remote management of applications and devices with limited resources, see http://www.osgi.org) OSGi platform is one Java instance in which all Java applications (bundles) are running. Management services are standardized and provided (e.g. HTTP services, Servlet container, Log service, Configuration admin etc.). These services help to remotely control, install and configure these bundles. The application control service (Device management agent) is also standardized by the OMA.
Payload	Part of a message that carries custom/user data.
PKI	See public key infrastructure.
PoS	Point-of-Sales that is used for tracking sales transactions (e.g. till in a supermarket)
QoS	Quality of Service
replication	In database management, the function that keeps distributed databases synchronized by routinely copying the entire database or subsets of the database to other servers in the network. There are several methods of replication, including primary site replication, shared or transferred ownership replication, symmetric replication, (also known as update-anywhere or peer-to-peer replication), and failover replication. Active Directory provides multi-master replication, which is a form of symmetric replication (see multi-master replication).
REST	Representational State Transfer (“The external interface of a typical REST-style application consists of a large number of Uniform Resource Identifier (URI) addressable resources and a few operations, such as Create, Read, Update, and Delete (CRUD). The advantage of this architectural style is its simplicity.” From http://www.ibm.com/developerworks/websphere/library/techarticles/0708_colonnese/0708_colonnese.html ; 20.07.2008)
RUP	Rational^® Unified Process Software and solution development methodology.
SAX	Serial Access parser API for XML that helps reading data from an XML formatted document. Alternative to the Document Object Model (DOM).
SLES^®	Novell^® SuSE^® Linux^® Enterprise Server
SOA	Service Oriented Architecture
SOAP	Simple Object Access Protocol: Protocol which is used in SOA to access objects over standard transport protocols, like HTTP
XPDinteg / Expeditor integrator	Expeditor integrator is a light-weight integration hub for the stores. This component integrates the in-store processes with back-end systems (XPDinteg).
SyncML	The OMA Data Synchronization Working Group continues the work originated in the former SyncML Initiative (see OMA-DS)
TCO	Total Cost of Ownership (full lifecycle view of costs for a solution)
UTF-8	Single-byte encoding
WeSphere Message Broker	IBM’s messaging server product (http://www-306.ibm.com/software/integration/wbimessagebroker/ , 16.01.2008)
WPS	WebSphere^® Process Server: one of IBM’s WebSphere Business Integration products
XPD	IBM^® Lotus^® Expeditor: IBM middleware which provides most of the Distributed Client Extension Services (Thin and Rich Distributed client extension services)